[WCM] Update docs to use get/setParentDocument instead of get/setParent. #491
Conversation
benglass
commented
May 13, 2014
benglass
commented
| Q | A |
|---|---|
| Doc fix? | yes |
| New docs? | yes (symfony-cmf/MenuBundle 1.1) |
| Applies to | symfony-cmf/MenuBundle 1.1+ |
| @@ -18,13 +18,13 @@ the KnpMenu component documentation for more information. | |||
|
|
|||
| .. code-block:: php | |||
|
|
|||
| use Symfony\Cmf\Bundle\MenuBundle\Doctrine\Phpcr\MenuNodeBase; | |||
| use Symfony\Cmf\Bundle\MenuBundle\Doctrine\Phpcr\MenuNode; | |||
|
|
|||
| $parent = ...; | |||
|
|
|||
| // ODM specific | |||
| $node = new MenuNodeBase(); | |||
There was a problem hiding this comment.
this also needs to be changed. i would combine this section with the one below and only talk about the MenuNode and not about MenuNodeBase (that class is basically to extend in other classes).
you could convert the intro talking about base things to a sidebar or .. note:: and just explain how to use the MenuNode.
|
|
||
| $parent = ...; | ||
|
|
||
| // ODM specific | ||
| $node = new MenuNodeBase(); | ||
| $node->setParent($parent); | ||
| $node = new MenuNode(); |
There was a problem hiding this comment.
now the title of the section is wrong ;-)
i re-copy my comment that is now hidden by github: i would combine this section with the one below and only talk about the MenuNode and not about MenuNodeBase (that class is basically to extend in other classes).
you could convert the intro talking about base things to a sidebar or .. note:: and just explain how to use the MenuNode.
There was a problem hiding this comment.
I don't think we should remove the *Base document documentation. It's essential to know that the CMF does not require any third party lib
There was a problem hiding this comment.
@dbu @wouterj This doc PR will have to wait until symfony-cmf/menu-bundle#190 is resolved (hopefully this can all happen today)
There was a problem hiding this comment.
There was a problem hiding this comment.
@wouterj i just am afraid that this will lead to confusion for the users. but if we go that way, this section should only explain how to set the label and such things that are in the Model class. and then the next section explains how to persist a doctrine menu node.
There was a problem hiding this comment.
symfony-cmf/menu-bundle#191 has been merged
There was a problem hiding this comment.
@dbu well, let's leave it now and see how we do that after 1.1 stable :)
There was a problem hiding this comment.
okay but lets open an issue so we don't forget.
wouterj
changed the title
|
this is not mergable anymore. recreated as #496 |
